/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.client.serializer;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;

import jp.fores.midori.core.dto.RPCInputDto;
import jp.fores.midori.server.exception.MidoriServerException;
import jp.fores.midori.server.exception.MidoriServerUnRecoveryException;
import jp.fores.midori.server.plugin.impl.JsonRPCPlugin;
import net.arnx.jsonic.JSON;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * リモートプロシージャーコールのシリアライズ・デシリアライズ処理を行うインターフェースのJSON-RPC形式の実装クラス。<br>
 * (このクラスの全てのメソッドはスレッドセーフです。)<br>
 */
public class JsonRPCSerializer implements RPCSerializer {
	//==========================================================
	//定数

	/**
	 * ログ出力用
	 */
	private static final Log log = LogFactory.getLog(JsonRPCSerializer.class);

	/**
	 * Content-Typeに設定する値
	 */
	public static final String CONTENT_TYPE = "application/json";


	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//抽象メソッドの実装

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getContentType() {
		//定数の値を返す
		return CONTENT_TYPE;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void inputDtoToOutputStream(RPCInputDto inputDto, OutputStream os)
			throws Exception {
		//==========================================================
		//下準備

		//JSONICのJSONクラスのインスタンスを生成
		JSON json = new JSON();

		//JSONクラスのロケールにデフォルトのロケールを設定する
		json.setLocale(Locale.getDefault());


		//==========================================================
		//RPCの入力データを格納するためのDTOをJSON-RPCのリクエスト形式にあわせたMapに変換

		//リクエスト形式にあわせたMapのインスタンスを生成
		//(出力する順番も意識する必要があるため、HashMapではなくLinkedHashMapを使う必要がある)
		Map<String, Object> requestMap = new LinkedHashMap<String, Object>();

		//リクエスト形式にあわせたMapの「method」に、メソッド名を設定
		requestMap.put("method", inputDto.methodName);

		//リクエスト形式にあわせたMapの「params」に、引数の配列を設定
		requestMap.put("params", inputDto.args);

		//リクエスト形式にあわせたMapの「id」に、通算ミリ秒数を設定
		//(TODO:本当は絶対に重複しない一意な値の方が良い)
		requestMap.put("id", System.currentTimeMillis());


		//==========================================================
		//作成したJSON-RPCのリクエスト形式にあわせたMapを元にして、出力ストリームに出力

		//デバッグログが有効な場合
		if (log.isDebugEnabled()) {
			//JSONの出力形式を可読性が高い形式にする
			json.setPrettyPrint(true);

			//作成したMapの内容をJSON形式の文字列に変換する
			String jsonStr = json.format(requestMap);

			//デバッグログが有効な場合
			if (log.isDebugEnabled()) {
				//デバッグログ出力
				log.debug("リクエストで送信するJSONの内容:" + jsonStr);
			}

			//作成したJSON形式の文字列をバイト配列に変換して、出力ストリームに出力する
			//(一応文字コードには、「UTF-8」を指定しておく)
			os.write(jsonStr.getBytes("UTF-8"));
		}
		//それ以外の場合
		else {
			//JSONクラスを使って、作成したMapをJSON形式に変換しながら出力ストリームに出力する
			json.format(requestMap, os);
		}
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Object handleRPCResponseInputStream(InputStream is) throws Exception {
		//==========================================================
		//下準備

		//JSONICのJSONクラスのインスタンスを生成
		JSON json = new JSON();

		//JSONクラスのロケールにデフォルトのロケールを設定する
		json.setLocale(Locale.getDefault());


		//==========================================================
		//入力ストリームの内容をJSON-RPC形式のMapに変換

		//JSONクラスを使って、入力ストリームの内容(JSON形式の文字列)をMapに変換する
		Map<String, Object> map = (Map) json.parse(is);

		//デバッグログが有効な場合
		if (log.isDebugEnabled()) {
			//デバッグログ出力
			log.debug("JSON形式のレスポンスの内容のMap:" + map);
		}

		//Map自体が取得できなかった場合
		if (map == null) {
			//仕方が無いので、入出力例外を投げる
			throw new IOException("レスポンスの内容が不正です。");
		}

		//Mapにエラー情報が設定されていない場合
		//(RPCが正常終了した場合)
		if (map.get("error") == null) {
			//Mapに設定されているRPCの戻り値を取得して返す
			return map.get("result");
		}
		//それ以外の場合
		//(RPCが異常終了した場合)
		else {
			//エラー情報を格納するためのMapを取得
			Map<String, Object> errorMap = (Map) map.get("error");

			//エラー情報を格納するためのMapからエラーメッセージを取得
			String message = (String) errorMap.get("message");


			//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
			//エラーコードに応じて投げる例外を切り分ける

			//エラー情報を格納するためのMapからエラーコードを取得
			//(JSONICでは数値の戻り値の型はBigDecimalなので、直接intにはキャストできないのでこのようにNumber経由で変換している)
			int errorCode = ((Number) errorMap.get("code")).intValue();

			//エラーコードが回復不能なエラーに属する場合
			if ((errorCode == JsonRPCPlugin.ERROR_CODE_PARSE_ERROR)
					|| (errorCode == JsonRPCPlugin.ERROR_CODE_INVALID_REQUEST)
					|| (errorCode == JsonRPCPlugin.ERROR_CODE_METHOD_NOT_FOUND)
					|| (errorCode == JsonRPCPlugin.ERROR_CODE_INVALID_PARAMS)) {
				//取得したエラーメッセージを元にして、midoriのサーバー側で発生する回復不能な例外を作成して投げる
				//(RPCClientCallerからの不毛な呼び出しを減らすため)
				throw new MidoriServerUnRecoveryException(message);
			}
			//それ以外の場合
			else {
				//取得したエラーメッセージを元にして、midoriのサーバー側で発生する例外を作成して投げる
				throw new MidoriServerException(message);
			}
		}
	}

}
